/*
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * NullStemmer.java
 * Copyright (C) 2005 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.core.stemmers;

import weka.core.RevisionUtils;

/**
 * <!-- globalinfo-start --> A dummy stemmer that performs no stemming at all.
 * <p/>
 * <!-- globalinfo-end -->
 * 
 * @author FracPete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 1.5 $
 */
public class NullStemmer implements Stemmer {

	/** for serialization */
	static final long serialVersionUID = -3671261636532625496L;

	/**
	 * Returns a string describing the stemmer
	 * 
	 * @return a description suitable for displaying in the
	 *         explorer/experimenter gui
	 */
	public String globalInfo() {
		return "A dummy stemmer that performs no stemming at all.";
	}

	/**
	 * Returns the word as it is.
	 * 
	 * @param word
	 *            the unstemmed word
	 * @return the unstemmed word, again
	 */
	public String stem(String word) {
		return new String(word);
	}

	/**
	 * returns a string representation of the stemmer
	 * 
	 * @return a string representation of the stemmer
	 */
	public String toString() {
		return getClass().getName();
	}

	/**
	 * Returns the revision string.
	 * 
	 * @return the revision
	 */
	public String getRevision() {
		return RevisionUtils.extract("$Revision: 1.5 $");
	}

	/**
	 * Runs the stemmer with the given options
	 * 
	 * @param args
	 *            the options
	 */
	public static void main(String[] args) {
		try {
			Stemming.useStemmer(new NullStemmer(), args);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}
